APIs at Yottaa

To support product development and customer success, Yottaa has several sets of APIs which serve different purposes.

• Data APIs

• Rapid JS Library APIs

• Yottaa APIs

Data APIs

The Data APIs facilitate the collection, analysis, and display of analytics data, third party information and performance data, details about user sessions and conversion insights, metrics on site performance and violations, and community and group data. The Data APIs are all RESTful requests using the GET method.

Rapid+JS Library APIs

The Rapid+JS Library contains the APIs that enable Yottaa to work its magic in speeding up e-commerce websites.

Yottaa's Rapid+JS Library is a modular JavaScript library used to control the loading and sequencing of resources used by a web application. Whether the resources are injected via source or third party or by making internal or external call-outs, Rapid+JS provides the granular control necessary to ensure that the key components of your web application that drive engagement are free from bottlenecks and load fast, ensuring an optimal end user experience and driving increased engagement and conversion.

The Rapid+JS Library APIs are all JavaScript functions.

• The sequencing APIs order and control the loading of resources on your site, to create a fast, streamlined user experience.

• The messaging APIs allow you to publish messages on specified topics, subscribe to topics to receive their messages, and unsubscribe from topics. You can interact with system events and also utilize the messaging system for your own events.

• The geo-location APIs allow you to target individual shoppers specifically based on their real-time geo-location data.

• The utility APIs simplify some common housekeeping tasks that you need to perform when integrating Yottaa and managing your application.

Yottaa APIs

The Yottaa APIs allow you to access and manage information residing in Yottaa. Yottaa provides three kinds of APIs for different groups of Yottaa customers:

• Partner APIs

• User APIs

• Public APIs

The Yottaa APIs all use a RESTful style interface. You can simulate the PUT/DELETE HTTP request method using POST method by contain the method parameter in the POST body, and the value should be put or delete. You can also send a real HTTP PUT/DELETE method. Either one will be accepted.

All Yottaa API requests must include the API KEY for a registered Yottaa account, and may require additional security information depending on the type. For example, every Partner API request must contain a valid API Key and Partner (User) ID. If either is missing, the Partner API request returns an HTTP 403 (Access Denied) response code.

Partner APIs

Yottaa provides a robust set of partner APIs that allow a third party partner to create and manage user accounts. The API allows partners with an existing user base to integrate Yottaa's web performance and monitoring solution.

Third party applications wanting to use the partner API must register for a Yottaa account and have the partner access granted. Partner applicants must contact Yottaa at <support@yottaa.com> to access partner API service. Once the applicant has been granted partner access, the partner APIs are available for use.

Yottaa Partner API uses the API key-based authentication method. Every Partner API request must contain a valid API Key and Partner (User) ID. If either is missing, the Partner API request returns an HTTP 403 (Access Denied) response code. You must log in to your account in Yottaa to get your API key under the account settings page.

User APIs

The User APIs allow third party applications to access information and settings that are within the data structures describing a specific user.

User APIs also allow the end user to access your own data at Yottaa. As end user, you can access the User APIs with your API Key and User ID, and you can get them at your "API Key" Page (apps.yottaa.com/permissions/profile/settings).

Public APIs

Yottaa's public API provides access to all the data within the Yottaa system that can be seen without logging. This data is broken into three areas:

• URLs - Applications can access public information that you have collected about any URL.

• Benchmarks - Users can create publicly visible benchmarks that can be used to compare URLs.

• Reports - Yottaa has a large amount of data that can be used to draw conclusions about website performance. From time to time, Yottaa adds new and interesting reports about the websites we track.

Third party applications wanting to use the public API must register for a Yottaa account. Within the user account settings you will see the "API Access" section. Click the "Enable Access" button to get your API key.

Add the API key to your REST request as a HTTP Header, for example:

YOTTAA-API-KEY: 7d04a0b7dc6afad374fa2e86c39fc49b0

Requests that do not contain a valid API Key return an HTTP 403 (Access Denied) response code.